package com.zhiyou100.entity;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 服务器端发生错误时，返回给前段的响应信息
 *
 * 必须包含 HTTP 状态码,errorCode、errorMessage、用户提示信息四个部分。
 * <p>
 * 四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。
 * 其中输出给用户的提示信息要求:简短清晰、提示友好,引导用户进行下一步操作或解释错误原因,
 * 提示信息可以包括错误原因、上下文环境、推荐操作等。
 * errorCode:参考附表
 * errorMessage:简要描述后端出错原因,便于错误排查人员快速定位问题,注意不要包含敏感数据信息。
 *
 * @author yang
 * @version 1.0.0
 * @date 2020-09-25 22:32
 */

@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ErrorMessage {
    /**
     * HTTP 状态码
     */
    private Integer statusCode;
    /**
     * errorCode 错误码
     */
    private String errorCode;
    /**
     * errorMessage 错误信息
     * errorMessage:简要描述后端出错原因,便于错误排查人员快速定位问题,注意不要包含敏感数据信息。
     */
    private String errorMessage;
    /**
     * 用户提示信息
     * 要求:简短清晰、提示友好,引导用户进行下一步操作或解释错误原因,
     */
    private String userPromptMessage;
}
